Document how to get gtk-doc-for-gtk4 orig source

diff --git a/debian/README.source b/debian/README.source
new file mode 100644 (file)
index 0000000..82ff9e3
--- /dev/null
+++ b/debian/README.source
@@ -0,0 +1,11 @@
+Bundled copy of gtk-doc
+-----------------------
+
+Until there is a gtk-doc release with
+https://gitlab.gnome.org/GNOME/gtk-doc/-/merge_requests/30 merged, we need
+to use gtk-doc from the gtk-doc-for-gtk4 git branch to document GTK 4.
+
+Check out an appropriate commit from upstream git, build a tarball with
+"meson dist", put it next to the orig.tar.xz for GTK 4 itself and rename
+it to gtk+4.0_${VERSION}.orig-gtk-doc-for-gtk4.tar.xz before importing a
+new upstream version ${VERSION}.

diff --git a/debian/copyright b/debian/copyright
index 44cb33407baa8e4cab10094f8b271934dc24e3d4..86b92dc3d1015d0fc719e81be3af966e3157371a 100644 (file)
--- a/debian/copyright
+++ b/debian/copyright
@@ -418,6 +418,8 @@ Comment:
  as a first-class feature alongside signals and properties; the branch
  implementing this has not yet been merged into the master branch
  of gtk-doc, so we bundle a suitably branched copy here for now.
+ .
+ See debian/README.source for more details.
 
 License: LGPL-2+
  This library is free software; you can redistribute it and/or modify it